Carbon


HomeResFile

Header: Resources.h Carbon status: Supported

Gets the file reference number associated with a particular resource.

SInt16 HomeResFile (
    Handle theResource
);
theResource

A handle to the resource for which you wish to get the associated file reference number.

function result

The file reference number for the resource fork containing the specified resource. If the given handle isn’t a handle to a resource, the function returns –1, and the ResError function returns the result code resNotFound. If HomeResFile returns 0, the resource is in the System file’s resource fork. If it returns 1, the resource is ROM-resident.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.


© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)